<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>DeepUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/azeckoski/reflectutils/DeepUtils.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: DeepUtils.html 21 2008-10-01 15:13:25Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://reflectutils.googlecode.com/svn/maven/site/xref/org/azeckoski/reflectutils/DeepUtils.html $</em>
<a name="4" href="#4">4</a>   <em> * FieldUtils.java - genericdao - May 19, 2008 10:10:15 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2.0</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski @ gmail.com) (aaronz @ vt.edu) (aaron @ caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.azeckoski.reflectutils;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.lang.ref.SoftReference;
<a name="18" href="#18">18</a>  <strong>import</strong> java.lang.reflect.Array;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.ArrayList;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.Collection;
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.HashMap;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.List;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Map;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Set;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Map.Entry;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassFields.FieldsFilter;
<a name="28" href="#28">28</a>  <strong>import</strong> org.azeckoski.reflectutils.beanutils.FieldAdapter;
<a name="29" href="#29">29</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldGetValueException;
<a name="30" href="#30">30</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldSetValueException;
<a name="31" href="#31">31</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldnameNotFoundException;
<a name="32" href="#32">32</a>  <strong>import</strong> org.azeckoski.reflectutils.map.ArrayOrderedMap;
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>  <em>/**<em>*</em></em>
<a name="35" href="#35">35</a>  <em> * Class which provides methods for handling deep operations: &lt;br/></em>
<a name="36" href="#36">36</a>  <em> * deep copy - make a copy of one object into another which traverses the entire object and duplicates all data down to immutable/simple fields &lt;br/></em>
<a name="37" href="#37">37</a>  <em> * deep clone - clone an object by traversing it and making a copy of every field &lt;br/></em>
<a name="38" href="#38">38</a>  <em> * deep map - turn an object into a map with only simple objects in it, all contained objects become nested maps &lt;br/></em>
<a name="39" href="#39">39</a>  <em> * populate - turn a map into an object, can handle params maps (from a servlet request) and nested or non-nested string->object maps</em>
<a name="40" href="#40">40</a>  <em> * </em>
<a name="41" href="#41">41</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="42" href="#42">42</a>  <em> */</em>
<a name="43" href="#43">43</a>  <strong>public</strong> <strong>class</strong> <a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a> {
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>      <em>/**<em>*</em></em>
<a name="46" href="#46">46</a>  <em>     * Empty constructor</em>
<a name="47" href="#47">47</a>  <em>     * &lt;br/></em>
<a name="48" href="#48">48</a>  <em>     * &lt;b>WARNING:&lt;/b> use the {@link #getInstance()} method to get this rather than recreating it over and over</em>
<a name="49" href="#49">49</a>  <em>     */</em>
<a name="50" href="#50">50</a>      <strong>public</strong> <a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a>() {
<a name="51" href="#51">51</a>          DeepUtils.setInstance(<strong>this</strong>);
<a name="52" href="#52">52</a>      }
<a name="53" href="#53">53</a>  
<a name="54" href="#54">54</a>      <strong>protected</strong> <a href="../../../org/azeckoski/reflectutils/ClassDataCacher.html">ClassDataCacher</a> getClassDataCacher() {
<a name="55" href="#55">55</a>          <strong>return</strong> ClassDataCacher.getInstance();
<a name="56" href="#56">56</a>      }
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <strong>protected</strong> <a href="../../../org/azeckoski/reflectutils/ConstructorUtils.html">ConstructorUtils</a> getConstructorUtils() {
<a name="59" href="#59">59</a>          <strong>return</strong> ConstructorUtils.getInstance();
<a name="60" href="#60">60</a>      }
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>      <strong>protected</strong> <a href="../../../org/azeckoski/reflectutils/ConversionUtils.html">ConversionUtils</a> getConversionUtils() {
<a name="63" href="#63">63</a>          <strong>return</strong> ConversionUtils.getInstance();
<a name="64" href="#64">64</a>      }
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      <strong>protected</strong> <a href="../../../org/azeckoski/reflectutils/FieldUtils.html">FieldUtils</a> getFieldUtils() {
<a name="67" href="#67">67</a>          <strong>return</strong> FieldUtils.getInstance();
<a name="68" href="#68">68</a>      }
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <strong>protected</strong> <a href="../../../org/azeckoski/reflectutils/beanutils/FieldAdapter.html">FieldAdapter</a> getFieldAdapter() {
<a name="71" href="#71">71</a>          <strong>return</strong> getFieldUtils().getFieldAdapter();
<a name="72" href="#72">72</a>      }
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em>/**<em>*</em></em>
<a name="75" href="#75">75</a>  <em>     * Deep clone an object and all the values in it into a brand new object of the same type,</em>
<a name="76" href="#76">76</a>  <em>     * this will traverse the bean and will make new objects for all non-null values contained in the object</em>
<a name="77" href="#77">77</a>  <em>     * </em>
<a name="78" href="#78">78</a>  <em>     * @param &lt;T></em>
<a name="79" href="#79">79</a>  <em>     * @param object any java object, this can be a list, map, array, or any simple</em>
<a name="80" href="#80">80</a>  <em>     * object, it does not have to be a custom object or even a java bean,</em>
<a name="81" href="#81">81</a>  <em>     * also works with DynaBeans</em>
<a name="82" href="#82">82</a>  <em>     * @param maxDepth the number of objects to follow when traveling through the object and copying</em>
<a name="83" href="#83">83</a>  <em>     * the values from it, 0 means to only copy the simple values in the object, any objects will</em>
<a name="84" href="#84">84</a>  <em>     * be ignored and will end up as nulls, 1 means to follow the first objects found and copy all</em>
<a name="85" href="#85">85</a>  <em>     * of their simple values as well, and so forth</em>
<a name="86" href="#86">86</a>  <em>     * @param fieldNamesToSkip (optional) the names of fields to skip while cloning this object,</em>
<a name="87" href="#87">87</a>  <em>     * this only has an effect on the bottom level of the object, any fields found</em>
<a name="88" href="#88">88</a>  <em>     * on child objects will always be copied (if the maxDepth allows)</em>
<a name="89" href="#89">89</a>  <em>     * @return the cloned object</em>
<a name="90" href="#90">90</a>  <em>     */</em>
<a name="91" href="#91">91</a>      @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="92" href="#92">92</a>      <strong>public</strong> &lt;T> T deepClone(T object, <strong>int</strong> maxDepth, String[] fieldNamesToSkip) {
<a name="93" href="#93">93</a>          Set&lt;String> skip = ArrayUtils.makeSetFromArray(fieldNamesToSkip);
<a name="94" href="#94">94</a>          T clone = (T) internalDeepClone(object, CopyDestination.ORIGINAL, maxDepth, skip, 0, <strong>true</strong>, false);
<a name="95" href="#95">95</a>          <strong>return</strong> clone;
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <em>/**<em>*</em></em>
<a name="99" href="#99">99</a>  <em>     * Deep copies one object into another, this is primarily for copying between identical types of objects but</em>
<a name="100" href="#100">100</a> <em>     * it can also handle copying between objects which are quite different, </em>
<a name="101" href="#101">101</a> <em>     * this does not just do a reference copy of the values but actually creates new objects in the current classloader</em>
<a name="102" href="#102">102</a> <em>     * </em>
<a name="103" href="#103">103</a> <em>     * @param orig the original object to copy from</em>
<a name="104" href="#104">104</a> <em>     * @param dest the object to copy the values to (must have the same fields with the same types)</em>
<a name="105" href="#105">105</a> <em>     * @param maxDepth the number of objects to follow when traveling through the object and copying</em>
<a name="106" href="#106">106</a> <em>     * the values from it, 0 means to only copy the simple values in the object, any objects will</em>
<a name="107" href="#107">107</a> <em>     * be ignored and will end up as nulls, 1 means to follow the first objects found and copy all</em>
<a name="108" href="#108">108</a> <em>     * of their simple values as well, and so forth</em>
<a name="109" href="#109">109</a> <em>     * @param fieldNamesToSkip (optional) the names of fields to skip while cloning this object,</em>
<a name="110" href="#110">110</a> <em>     * this only has an effect on the bottom level of the object, any fields found</em>
<a name="111" href="#111">111</a> <em>     * on child objects will always be copied (if the maxDepth allows)</em>
<a name="112" href="#112">112</a> <em>     * @param ignoreNulls if true then nulls are not copied and the destination retains the value it has,</em>
<a name="113" href="#113">113</a> <em>     * if false then nulls are copied and the destination value will become a null if the original value is a null</em>
<a name="114" href="#114">114</a> <em>     * @throws IllegalArgumentException if the copy cannot be completed because the objects to copy do not have matching fields or types</em>
<a name="115" href="#115">115</a> <em>     */</em>
<a name="116" href="#116">116</a>     <strong>public</strong> <strong>void</strong> deepCopy(Object orig, Object dest, <strong>int</strong> maxDepth, String[] fieldNamesToSkip, <strong>boolean</strong> ignoreNulls) {
<a name="117" href="#117">117</a>         Set&lt;String> skip = ArrayUtils.makeSetFromArray(fieldNamesToSkip);
<a name="118" href="#118">118</a>         internalDeepCopy(orig, dest, maxDepth, skip, ignoreNulls, <strong>true</strong>);
<a name="119" href="#119">119</a>     }
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>     <em>/**<em>*</em></em>
<a name="122" href="#122">122</a> <em>     * This handles the copying of objects to maps, it is recursive and is a deep operation which</em>
<a name="123" href="#123">123</a> <em>     * traverses the entire object and clones every part of it. When converting to a map this will ensure</em>
<a name="124" href="#124">124</a> <em>     * that there are no objects which are not part of java.lang or java.util in the new map&lt;br/></em>
<a name="125" href="#125">125</a> <em>     * NOTE: This can handle simple objects (non-maps and non-beans) but will have to make up the initial map key</em>
<a name="126" href="#126">126</a> <em>     * in the returned map, "data" will be used as the key&lt;br/></em>
<a name="127" href="#127">127</a> <em>     * NOTE: Nulls are allowed to pass through this method (i.e. passing in a null object results in a null output)</em>
<a name="128" href="#128">128</a> <em>     * </em>
<a name="129" href="#129">129</a> <em>     * @param bean any java object</em>
<a name="130" href="#130">130</a> <em>     * @param maxDepth the number of objects to follow when traveling through the object and copying</em>
<a name="131" href="#131">131</a> <em>     * the values from it, 0 means to only copy the simple values in the object, any objects will</em>
<a name="132" href="#132">132</a> <em>     * be ignored and will end up as nulls, 1 means to follow the first objects found and copy all</em>
<a name="133" href="#133">133</a> <em>     * of their simple values as well, and so forth</em>
<a name="134" href="#134">134</a> <em>     * @param fieldNamesToSkip (optional) the names of fields to skip while cloning this object,</em>
<a name="135" href="#135">135</a> <em>     * this only has an effect on the bottom level of the object, any fields found</em>
<a name="136" href="#136">136</a> <em>     * on child objects will always be copied (if the maxDepth allows)</em>
<a name="137" href="#137">137</a> <em>     * @param ignoreNulls if true then nulls are not copied and the destination retains the value it has,</em>
<a name="138" href="#138">138</a> <em>     * if false then nulls are copied and the destination value will become a null if the original value is a null</em>
<a name="139" href="#139">139</a> <em>     * @param ignoreTransient if true then all transient fields will be skipped, useful when serializing</em>
<a name="140" href="#140">140</a> <em>     * @param initialKey (optional) the initial key to use when simple objects are converted to maps, defaults to "data"</em>
<a name="141" href="#141">141</a> <em>     * @return the resulting map which contains the cloned data from the object</em>
<a name="142" href="#142">142</a> <em>     */</em>
<a name="143" href="#143">143</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="144" href="#144">144</a>     <strong>public</strong> Map&lt;String, Object> deepMap(Object object, <strong>int</strong> maxDepth, String[] fieldNamesToSkip, <strong>boolean</strong> ignoreNulls, <strong>boolean</strong> ignoreTransient, String initialKey) {
<a name="145" href="#145">145</a>         Set&lt;String> skip = ArrayUtils.makeSetFromArray(fieldNamesToSkip);
<a name="146" href="#146">146</a>         Object clone = internalDeepClone(object, CopyDestination.MAP, maxDepth, skip, 0, ignoreNulls, ignoreTransient);
<a name="147" href="#147">147</a>         Map&lt;String, Object> map = <strong>null</strong>;
<a name="148" href="#148">148</a>         <strong>if</strong> (clone != <strong>null</strong>) {
<a name="149" href="#149">149</a>             <strong>if</strong> ( ConstructorUtils.isClassMap(clone.getClass())) {
<a name="150" href="#150">150</a>                 map = (Map&lt;String, Object>) clone;
<a name="151" href="#151">151</a>             } <strong>else</strong> {
<a name="152" href="#152">152</a>                 <em class="comment">// handle the case of non-map/bean by wrapping in a map</em>
<a name="153" href="#153">153</a>                 <strong>if</strong> (initialKey == <strong>null</strong>) {
<a name="154" href="#154">154</a>                     initialKey = <span class="string">"data"</span>;
<a name="155" href="#155">155</a>                 }
<a name="156" href="#156">156</a>                 map = <strong>new</strong> HashMap&lt;String, Object>();
<a name="157" href="#157">157</a>                 map.put(initialKey, clone);
<a name="158" href="#158">158</a>             }
<a name="159" href="#159">159</a>         }
<a name="160" href="#160">160</a>         <strong>return</strong> map;
<a name="161" href="#161">161</a>     }
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em>/**<em>*</em></em>
<a name="164" href="#164">164</a> <em>     * Populates an object with the values in the properties map,</em>
<a name="165" href="#165">165</a> <em>     * this will not fail if the fieldName in the map is not a property on the</em>
<a name="166" href="#166">166</a> <em>     * object or the fieldName cannot be written to with the value in the object.</em>
<a name="167" href="#167">167</a> <em>     * This will attempt to convert the provided object values into the right values</em>
<a name="168" href="#168">168</a> <em>     * to place in the object&lt;br/></em>
<a name="169" href="#169">169</a> <em>     * &lt;b>NOTE:&lt;/b> simple types like numbers and strings can almost always be converted from</em>
<a name="170" href="#170">170</a> <em>     * just about anything though they will probably end up as 0 or ""&lt;br/></em>
<a name="171" href="#171">171</a> <em>     * Setting fields supports simple, nested, indexed, and mapped values:&lt;br/></em>
<a name="172" href="#172">172</a> <em>     * &lt;b>Simple:&lt;/b> Get/set a field in a bean (or map), Example: "title", "id"&lt;br/></em>
<a name="173" href="#173">173</a> <em>     * &lt;b>Nested:&lt;/b> Get/set a field in a bean which is contained in another bean, Example: "someBean.title", "someBean.id"&lt;br/></em>
<a name="174" href="#174">174</a> <em>     * &lt;b>Indexed:&lt;/b> Get/set a list/array item by index in a bean, Example: "myList[1]", "anArray[2]"&lt;br/></em>
<a name="175" href="#175">175</a> <em>     * &lt;b>Mapped:&lt;/b> Get/set a map entry by key in a bean, Example: "myMap(key)", "someMap(thing)"&lt;br/></em>
<a name="176" href="#176">176</a> <em>     * </em>
<a name="177" href="#177">177</a> <em>     * @param object any object</em>
<a name="178" href="#178">178</a> <em>     * @param properties a map of fieldNames -> Object</em>
<a name="179" href="#179">179</a> <em>     * @return the list of fieldNames which were successfully written to the object</em>
<a name="180" href="#180">180</a> <em>     * @throws IllegalArgumentException if the arguments are invalid</em>
<a name="181" href="#181">181</a> <em>     */</em>
<a name="182" href="#182">182</a>     <strong>public</strong> List&lt;String> populate(Object object, Map&lt;String, Object> properties) {
<a name="183" href="#183">183</a>         <strong>if</strong> (object == <strong>null</strong> || properties == <strong>null</strong>) {
<a name="184" href="#184">184</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"object and properties cannot be null"</span>);
<a name="185" href="#185">185</a>         }
<a name="186" href="#186">186</a>         Map&lt;String, Class&lt;?>> fieldTypes = getFieldUtils().getFieldTypes(object.getClass(), FieldsFilter.ALL);
<a name="187" href="#187">187</a>         List&lt;String> writtenFields = <strong>new</strong> ArrayList&lt;String>();
<a name="188" href="#188">188</a>         <strong>for</strong> (Entry&lt;String, Object> entry : properties.entrySet()) {
<a name="189" href="#189">189</a>             String fieldName = entry.getKey();
<a name="190" href="#190">190</a>             <strong>if</strong> (fieldName != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(fieldName)) {
<a name="191" href="#191">191</a>                 Class&lt;?> targetType = fieldTypes.get(fieldName);
<a name="192" href="#192">192</a>                 <strong>if</strong> (targetType != <strong>null</strong>) {
<a name="193" href="#193">193</a>                     Object value = entry.getValue();
<a name="194" href="#194">194</a>                     <strong>try</strong> {
<a name="195" href="#195">195</a>                         <strong>if</strong> ( ConstructorUtils.isClassSimple(targetType) ) {
<a name="196" href="#196">196</a>                             <em class="comment">// this should write the value or fail</em>
<a name="197" href="#197">197</a>                             getFieldUtils().setFieldValue(object, fieldName, value, <strong>true</strong>);
<a name="198" href="#198">198</a>                         } <strong>else</strong> {
<a name="199" href="#199">199</a>                             <em class="comment">// value is a bean so we will dig into it further</em>
<a name="200" href="#200">200</a>                             Object dest = getFieldUtils().getFieldValue(object, fieldName);
<a name="201" href="#201">201</a>                             <strong>if</strong> (dest == <strong>null</strong>) {
<a name="202" href="#202">202</a>                                 <em class="comment">// need to construct the destination</em>
<a name="203" href="#203">203</a>                                 <strong>if</strong> (value.getClass().isArray() &amp;&amp; targetType.isArray()) {
<a name="204" href="#204">204</a>                                     <em class="comment">// special case for array to array since the destination must match</em>
<a name="205" href="#205">205</a>                                     dest = ArrayUtils.template((Object[])value);
<a name="206" href="#206">206</a>                                 } <strong>else</strong> {
<a name="207" href="#207">207</a>                                     dest = getConstructorUtils().constructClass(targetType);
<a name="208" href="#208">208</a>                                 }
<a name="209" href="#209">209</a>                                 getFieldUtils().setFieldValue(object, fieldName, dest, <strong>true</strong>);
<a name="210" href="#210">210</a>                             }
<a name="211" href="#211">211</a>                             internalDeepCopy(value, dest, 5, <strong>null</strong>, false, <strong>true</strong>);
<a name="212" href="#212">212</a>                         }
<a name="213" href="#213">213</a>                         writtenFields.add(fieldName); <em class="comment">// record that the value was written successfully</em>
<a name="214" href="#214">214</a>                     } <strong>catch</strong> (RuntimeException e) {
<a name="215" href="#215">215</a>                         <em class="comment">// this is OK, it just means we did not write the value</em>
<a name="216" href="#216">216</a>                         <strong>continue</strong>;
<a name="217" href="#217">217</a>                     }
<a name="218" href="#218">218</a>                 }
<a name="219" href="#219">219</a>             }
<a name="220" href="#220">220</a>         }
<a name="221" href="#221">221</a>         <strong>return</strong> writtenFields;
<a name="222" href="#222">222</a>     }
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>     <em>/**<em>*</em></em>
<a name="225" href="#225">225</a> <em>     * Populates an object with the String array values in the params map,</em>
<a name="226" href="#226">226</a> <em>     * this will not fail if the fieldName in the map is not a property on the</em>
<a name="227" href="#227">227</a> <em>     * object or the fieldName cannot be written to with the value in the object&lt;br/></em>
<a name="228" href="#228">228</a> <em>     * Arrays which are length 1 will be converted to a string before they are set on the target field &lt;br/></em>
<a name="229" href="#229">229</a> <em>     * Setting fields supports simple, nested, indexed, and mapped values:&lt;br/></em>
<a name="230" href="#230">230</a> <em>     * &lt;b>Simple:&lt;/b> Get/set a field in a bean (or map), Example: "title", "id"&lt;br/></em>
<a name="231" href="#231">231</a> <em>     * &lt;b>Nested:&lt;/b> Get/set a field in a bean which is contained in another bean, Example: "someBean.title", "someBean.id"&lt;br/></em>
<a name="232" href="#232">232</a> <em>     * &lt;b>Indexed:&lt;/b> Get/set a list/array item by index in a bean, Example: "myList[1]", "anArray[2]"&lt;br/></em>
<a name="233" href="#233">233</a> <em>     * &lt;b>Mapped:&lt;/b> Get/set a map entry by key in a bean, Example: "myMap(key)", "someMap(thing)"&lt;br/></em>
<a name="234" href="#234">234</a> <em>     * </em>
<a name="235" href="#235">235</a> <em>     * @param object any object</em>
<a name="236" href="#236">236</a> <em>     * @param params a map of fieldNames -> String[] (normally from an http request)</em>
<a name="237" href="#237">237</a> <em>     * @return the list of fieldNames which were successfully written to the object</em>
<a name="238" href="#238">238</a> <em>     * @throws IllegalArgumentException if the arguments are invalid</em>
<a name="239" href="#239">239</a> <em>     */</em>
<a name="240" href="#240">240</a>     <strong>public</strong> List&lt;String> populateFromParams(Object object, Map&lt;String, String[]> params) {
<a name="241" href="#241">241</a>         <strong>if</strong> (object == <strong>null</strong> || params == <strong>null</strong>) {
<a name="242" href="#242">242</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"object and params cannot be null"</span>);
<a name="243" href="#243">243</a>         }
<a name="244" href="#244">244</a>         List&lt;String> writtenFields = <strong>new</strong> ArrayList&lt;String>();
<a name="245" href="#245">245</a>         <strong>for</strong> (Entry&lt;String, String[]> entry : params.entrySet()) {
<a name="246" href="#246">246</a>             String fieldName = entry.getKey();
<a name="247" href="#247">247</a>             <strong>if</strong> (fieldName != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(fieldName)) {
<a name="248" href="#248">248</a>                 String[] value = entry.getValue();
<a name="249" href="#249">249</a>                 <strong>try</strong> {
<a name="250" href="#250">250</a>                     <em class="comment">// this should write the value or fail</em>
<a name="251" href="#251">251</a>                     <strong>if</strong> (value != <strong>null</strong>) {
<a name="252" href="#252">252</a>                         Object toSet = value;
<a name="253" href="#253">253</a>                         <strong>if</strong> (value.length == 0) {
<a name="254" href="#254">254</a>                             toSet = <span class="string">""</span>;
<a name="255" href="#255">255</a>                         } <strong>else</strong> <strong>if</strong> (value.length == 1) {
<a name="256" href="#256">256</a>                             toSet = value[0];
<a name="257" href="#257">257</a>                         }
<a name="258" href="#258">258</a>                         getFieldUtils().setFieldValue(object, fieldName, toSet, <strong>true</strong>);
<a name="259" href="#259">259</a>                         writtenFields.add(fieldName); <em class="comment">// record that the value was written successfully</em>
<a name="260" href="#260">260</a>                     }
<a name="261" href="#261">261</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="262" href="#262">262</a>                     <em class="comment">// this is OK, it just means we did not write the value</em>
<a name="263" href="#263">263</a>                     <strong>continue</strong>;
<a name="264" href="#264">264</a>                 }
<a name="265" href="#265">265</a>             }
<a name="266" href="#266">266</a>         }
<a name="267" href="#267">267</a>         <strong>return</strong> writtenFields;
<a name="268" href="#268">268</a>     }
<a name="269" href="#269">269</a> 
<a name="270" href="#270">270</a> 
<a name="271" href="#271">271</a>     <strong>public</strong> <strong>static</strong> enum CopyDestination {ORIGINAL, MAP};
<a name="272" href="#272">272</a>     <em>/**<em>*</em></em>
<a name="273" href="#273">273</a> <em>     * This handles the cloning of objects to objects or maps, it is recursive and is a deep operation which</em>
<a name="274" href="#274">274</a> <em>     * traverses the entire object and clones every part of it, when converting to a map this will ensure</em>
<a name="275" href="#275">275</a> <em>     * that there are no objects which are not part of java.lang or java.util in the new map</em>
<a name="276" href="#276">276</a> <em>     * @param bean any java object</em>
<a name="277" href="#277">277</a> <em>     * @param dest the type of destination: ORIGINAL = an object of type matching bean, MAP = an ordered map</em>
<a name="278" href="#278">278</a> <em>     * @param maxDepth the number of objects to follow when traveling through the object and copying</em>
<a name="279" href="#279">279</a> <em>     * the values from it, 0 means to only copy the simple values in the object, any objects will</em>
<a name="280" href="#280">280</a> <em>     * be ignored and will end up as nulls, 1 means to follow the first objects found and copy all</em>
<a name="281" href="#281">281</a> <em>     * of their simple values as well, and so forth</em>
<a name="282" href="#282">282</a> <em>     * @param fieldNamesToSkip the names of fields to skip while cloning this object,</em>
<a name="283" href="#283">283</a> <em>     * this only has an effect on the bottom level of the object, any fields found</em>
<a name="284" href="#284">284</a> <em>     * on child objects will always be copied (if the maxDepth allows)</em>
<a name="285" href="#285">285</a> <em>     * @param currentDepth the current depth for recursion and halting when appropriate depth is reached</em>
<a name="286" href="#286">286</a> <em>     * @param ignoreNulls if true then nulls are not copied and the destination retains the value it has,</em>
<a name="287" href="#287">287</a> <em>     * if false then nulls are copied and the destination value will become a null if the original value is a null</em>
<a name="288" href="#288">288</a> <em>     * @param ignoreTransient if true then all transient fields will be skipped, useful when serializing</em>
<a name="289" href="#289">289</a> <em>     * @return the object or map which has been cloned</em>
<a name="290" href="#290">290</a> <em>     */</em>
<a name="291" href="#291">291</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="292" href="#292">292</a>     <strong>protected</strong> Object <strong>int</strong>ernalDeepClone(Object bean, CopyDestination dest, <strong>int</strong> maxDepth, Set&lt;String> fieldNamesToSkip, <strong>int</strong> currentDepth, <strong>boolean</strong> ignoreNulls, <strong>boolean</strong> ignoreTransient) {
<a name="293" href="#293">293</a>         Object copy = <strong>null</strong>;
<a name="294" href="#294">294</a>         <strong>if</strong> ( bean != <strong>null</strong> ) {
<a name="295" href="#295">295</a>             Class&lt;?> beanClass = bean.getClass();
<a name="296" href="#296">296</a>             <em class="comment">// always copy the simple types if possible</em>
<a name="297" href="#297">297</a>             <strong>if</strong> (ConstructorUtils.isClassSimple(beanClass)) {
<a name="298" href="#298">298</a>                 copy = bean;
<a name="299" href="#299">299</a>             } <strong>else</strong> {
<a name="300" href="#300">300</a>                 <strong>if</strong> (currentDepth &lt;= maxDepth) {
<a name="301" href="#301">301</a>                     currentDepth++;
<a name="302" href="#302">302</a>                     <strong>try</strong> {
<a name="303" href="#303">303</a>                         <em class="comment">// now do the cloning based on the thing to clone</em>
<a name="304" href="#304">304</a>                         <strong>if</strong> (beanClass.isArray()) {
<a name="305" href="#305">305</a>                             <em class="comment">// special case, use array reflection</em>
<a name="306" href="#306">306</a>                             <em class="comment">// make new array</em>
<a name="307" href="#307">307</a>                             <strong>int</strong> length = ArrayUtils.size((Object[]) bean);
<a name="308" href="#308">308</a>                             Class&lt;?> componentType = beanClass.getComponentType();
<a name="309" href="#309">309</a>                             <strong>if</strong> ( ConstructorUtils.isClassBean(componentType) 
<a name="310" href="#310">310</a>                                     &amp;&amp; CopyDestination.MAP.equals(dest)) {
<a name="311" href="#311">311</a>                                 <em class="comment">// special array component type for arrays of objects when map converting</em>
<a name="312" href="#312">312</a>                                 componentType = ArrayOrderedMap.<strong>class</strong>;
<a name="313" href="#313">313</a>                             }
<a name="314" href="#314">314</a>                             copy = ArrayUtils.create(componentType, length);
<a name="315" href="#315">315</a>                             <em class="comment">// now copy the stuff into it</em>
<a name="316" href="#316">316</a>                             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; length; i++) {
<a name="317" href="#317">317</a>                                 Object value = Array.get(bean, i);
<a name="318" href="#318">318</a>                                 Object clone = internalDeepClone(value, dest, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, ignoreTransient);
<a name="319" href="#319">319</a>                                 Array.set(copy, i, clone);
<a name="320" href="#320">320</a>                             }
<a name="321" href="#321">321</a>                         } <strong>else</strong> <strong>if</strong> (Collection.<strong>class</strong>.isAssignableFrom(beanClass)) {
<a name="322" href="#322">322</a>                             <em class="comment">// special case, clone everything in the list</em>
<a name="323" href="#323">323</a>                             copy = getConstructorUtils().constructClass(beanClass); <em class="comment">// make new list</em>
<a name="324" href="#324">324</a>                             <strong>for</strong> (Object element : (Collection) bean) {
<a name="325" href="#325">325</a>                                 Object clone = internalDeepClone(element, dest, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, ignoreTransient);
<a name="326" href="#326">326</a>                                 ((Collection) copy).add( clone );
<a name="327" href="#327">327</a>                             }
<a name="328" href="#328">328</a>                         } <strong>else</strong> <strong>if</strong> (Map.<strong>class</strong>.isAssignableFrom(beanClass)) {
<a name="329" href="#329">329</a>                             <em class="comment">// special case, clone everything in the map except keys</em>
<a name="330" href="#330">330</a>                             copy = getConstructorUtils().constructClass(beanClass); <em class="comment">// make new map</em>
<a name="331" href="#331">331</a>                             <strong>for</strong> (Object key : ((Map) bean).keySet()) {
<a name="332" href="#332">332</a>                                 <strong>if</strong> ( fieldNamesToSkip != <strong>null</strong>
<a name="333" href="#333">333</a>                                         &amp;&amp; fieldNamesToSkip.contains(key) ) {
<a name="334" href="#334">334</a>                                     <strong>continue</strong>; <em class="comment">// skip to next</em>
<a name="335" href="#335">335</a>                                 }
<a name="336" href="#336">336</a>                                 Object value = ((Map) bean).get(key);
<a name="337" href="#337">337</a>                                 <strong>if</strong> (value == <strong>null</strong> &amp;&amp; ignoreNulls) {
<a name="338" href="#338">338</a>                                     <strong>continue</strong>;
<a name="339" href="#339">339</a>                                 }
<a name="340" href="#340">340</a>                                 <strong>try</strong> {
<a name="341" href="#341">341</a>                                     ((Map) copy).put(key, 
<a name="342" href="#342">342</a>                                             internalDeepClone(value, dest, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, ignoreTransient) );
<a name="343" href="#343">343</a>                                 } <strong>catch</strong> (NullPointerException e) {
<a name="344" href="#344">344</a>                                     <em class="comment">// map does not support nulls so skip and keep going</em>
<a name="345" href="#345">345</a>                                     <strong>continue</strong>;
<a name="346" href="#346">346</a>                                 }                     
<a name="347" href="#347">347</a>                             }
<a name="348" href="#348">348</a>                         } <strong>else</strong> <strong>if</strong> (getFieldAdapter().isAdaptableClass(beanClass)) {
<a name="349" href="#349">349</a>                             <em class="comment">// special handling for dynabeans</em>
<a name="350" href="#350">350</a>                             <strong>if</strong> (CopyDestination.MAP.equals(dest)) {
<a name="351" href="#351">351</a>                                 copy = <strong>new</strong> ArrayOrderedMap&lt;String, Object>();
<a name="352" href="#352">352</a>                             } <strong>else</strong> {
<a name="353" href="#353">353</a>                                 copy = getFieldAdapter().newInstance(bean); <em class="comment">// make new dynabean</em>
<a name="354" href="#354">354</a>                             }
<a name="355" href="#355">355</a>                             List&lt;String> propertyNames = getFieldAdapter().getPropertyNames(bean);
<a name="356" href="#356">356</a>                             <strong>for</strong> (String name : propertyNames) {
<a name="357" href="#357">357</a>                                 <strong>if</strong> ( fieldNamesToSkip != <strong>null</strong>
<a name="358" href="#358">358</a>                                         &amp;&amp; fieldNamesToSkip.contains(name) ) {
<a name="359" href="#359">359</a>                                     <strong>continue</strong>; <em class="comment">// skip to next</em>
<a name="360" href="#360">360</a>                                 }
<a name="361" href="#361">361</a>                                 <strong>try</strong> {
<a name="362" href="#362">362</a>                                     Object value = getFieldAdapter().getSimpleValue(bean, name);
<a name="363" href="#363">363</a>                                     <strong>if</strong> (value == <strong>null</strong> &amp;&amp; ignoreNulls) {
<a name="364" href="#364">364</a>                                         <strong>continue</strong>;
<a name="365" href="#365">365</a>                                     }
<a name="366" href="#366">366</a>                                     <strong>if</strong> (CopyDestination.MAP.equals(dest)) {
<a name="367" href="#367">367</a>                                         ((Map&lt;String, Object>) copy).put(name, 
<a name="368" href="#368">368</a>                                                 internalDeepClone(value, dest, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, ignoreTransient) );
<a name="369" href="#369">369</a>                                     } <strong>else</strong> {
<a name="370" href="#370">370</a>                                         getFieldUtils().setFieldValue(copy, name, 
<a name="371" href="#371">371</a>                                                 internalDeepClone(value, dest, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, ignoreTransient) );
<a name="372" href="#372">372</a>                                     }
<a name="373" href="#373">373</a>                                 } <strong>catch</strong> (IllegalArgumentException e) {
<a name="374" href="#374">374</a>                                     <em class="comment">// this is ok, field might not be readable so we will not clone it, continue on</em>
<a name="375" href="#375">375</a>                                 }
<a name="376" href="#376">376</a>                             }
<a name="377" href="#377">377</a>                         } <strong>else</strong> {
<a name="378" href="#378">378</a>                             <em class="comment">// regular javabean</em>
<a name="379" href="#379">379</a>                             FieldsFilter filter = FieldsFilter.COMPLETE;
<a name="380" href="#380">380</a>                             <strong>if</strong> (CopyDestination.MAP.equals(dest)) {
<a name="381" href="#381">381</a>                                 copy = <strong>new</strong> ArrayOrderedMap&lt;String, Object>();
<a name="382" href="#382">382</a>                                 <em class="comment">// maps should pick up all readable fields</em>
<a name="383" href="#383">383</a>                                 <strong>if</strong> (ignoreTransient) {
<a name="384" href="#384">384</a>                                     filter = FieldsFilter.SERIALIZABLE;
<a name="385" href="#385">385</a>                                 } <strong>else</strong> {
<a name="386" href="#386">386</a>                                     filter = FieldsFilter.READABLE;
<a name="387" href="#387">387</a>                                 }
<a name="388" href="#388">388</a>                             } <strong>else</strong> {
<a name="389" href="#389">389</a>                                 copy = getConstructorUtils().constructClass(beanClass); <em class="comment">// make new bean</em>
<a name="390" href="#390">390</a>                             }
<a name="391" href="#391">391</a>                             ClassFields&lt;?> cf = getFieldUtils().analyzeClass(beanClass);
<a name="392" href="#392">392</a>                             Map&lt;String, Class&lt;?>> types = cf.getFieldTypes(filter);
<a name="393" href="#393">393</a>                             <strong>for</strong> (String name : types.keySet()) {
<a name="394" href="#394">394</a>                                 <strong>if</strong> (ClassFields.FIELD_CLASS.equals(name)) {
<a name="395" href="#395">395</a>                                     <strong>continue</strong>; <em class="comment">// No point in trying to set/get an object's class</em>
<a name="396" href="#396">396</a>                                 }
<a name="397" href="#397">397</a>                                 <strong>if</strong> ( fieldNamesToSkip != <strong>null</strong>
<a name="398" href="#398">398</a>                                         &amp;&amp; fieldNamesToSkip.contains(name) ) {
<a name="399" href="#399">399</a>                                     <strong>continue</strong>; <em class="comment">// skip to next</em>
<a name="400" href="#400">400</a>                                 }
<a name="401" href="#401">401</a>                                 <strong>try</strong> {
<a name="402" href="#402">402</a>                                     Object value = getFieldUtils().getFieldValue(bean, name);
<a name="403" href="#403">403</a>                                     <strong>if</strong> (value == <strong>null</strong> &amp;&amp; ignoreNulls) {
<a name="404" href="#404">404</a>                                         <strong>continue</strong>;
<a name="405" href="#405">405</a>                                     }
<a name="406" href="#406">406</a>                                     <strong>if</strong> (CopyDestination.MAP.equals(dest)) {
<a name="407" href="#407">407</a>                                         ((Map&lt;String, Object>) copy).put(name, 
<a name="408" href="#408">408</a>                                                 internalDeepClone(value, dest, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, ignoreTransient) );                     
<a name="409" href="#409">409</a>                                     } <strong>else</strong> {
<a name="410" href="#410">410</a>                                         getFieldUtils().setFieldValue(copy, name, 
<a name="411" href="#411">411</a>                                                 internalDeepClone(value, dest, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, ignoreTransient) );
<a name="412" href="#412">412</a>                                     }
<a name="413" href="#413">413</a>                                 } <strong>catch</strong> (FieldnameNotFoundException e) {
<a name="414" href="#414">414</a>                                     <em class="comment">// this is ok, field might not exist or might not be readable so we skip it</em>
<a name="415" href="#415">415</a>                                 } <strong>catch</strong> (FieldGetValueException e) {
<a name="416" href="#416">416</a>                                     <em class="comment">// this is ok, field might not be readable (it should be though)</em>
<a name="417" href="#417">417</a>                                 } <strong>catch</strong> (FieldSetValueException e) {
<a name="418" href="#418">418</a>                                     <em class="comment">// this is ok, field might not be writeable (should also not happen)</em>
<a name="419" href="#419">419</a>                                 } <strong>catch</strong> (IllegalArgumentException e) {
<a name="420" href="#420">420</a>                                     <em class="comment">// this is ok, failure should not stop the clone</em>
<a name="421" href="#421">421</a>                                 }
<a name="422" href="#422">422</a>                             }
<a name="423" href="#423">423</a>                         }
<a name="424" href="#424">424</a>                     } <strong>catch</strong> (Exception e) {
<a name="425" href="#425">425</a>                         <em class="comment">// catch any possible thrown exception and translate (this is not a mistake so ignore findbugs)</em>
<a name="426" href="#426">426</a>                         <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failure during deep cloning ("</span>+beanClass+<span class="string">") maxDepth="</span>+maxDepth+<span class="string">", currentDepth="</span>+currentDepth+<span class="string">": "</span> + e.getMessage(), e);
<a name="427" href="#427">427</a>                     }
<a name="428" href="#428">428</a>                 }
<a name="429" href="#429">429</a>             }
<a name="430" href="#430">430</a>         }
<a name="431" href="#431">431</a>         <strong>return</strong> copy;
<a name="432" href="#432">432</a>     }
<a name="433" href="#433">433</a> 
<a name="434" href="#434">434</a>     <em>/**<em>*</em></em>
<a name="435" href="#435">435</a> <em>     * @param orig the original object to copy from</em>
<a name="436" href="#436">436</a> <em>     * @param dest the object to copy the values to (must have the same fields with the same types)</em>
<a name="437" href="#437">437</a> <em>     * @param maxDepth the number of objects to follow when traveling through the object and copying</em>
<a name="438" href="#438">438</a> <em>     * the values from it, 0 means to only copy the simple values in the object, any objects will</em>
<a name="439" href="#439">439</a> <em>     * be ignored and will end up as nulls, 1 means to follow the first objects found and copy all</em>
<a name="440" href="#440">440</a> <em>     * of their simple values as well, and so forth</em>
<a name="441" href="#441">441</a> <em>     * @param fieldNamesToSkip the names of fields to skip while cloning this object,</em>
<a name="442" href="#442">442</a> <em>     * this only has an effect on the bottom level of the object, any fields found</em>
<a name="443" href="#443">443</a> <em>     * on child objects will always be copied (if the maxDepth allows)</em>
<a name="444" href="#444">444</a> <em>     * @param ignoreNulls if true then nulls are not copied and the destination retains the value it has,</em>
<a name="445" href="#445">445</a> <em>     * if false then nulls are copied and the destination value will become a null if the original value is a null</em>
<a name="446" href="#446">446</a> <em>     * @param autoConvert if true the the original will be converted to the dest type if needed</em>
<a name="447" href="#447">447</a> <em>     * @throws IllegalArgumentException if the copy cannot be completed because the objects to copy do not have matching fields or types</em>
<a name="448" href="#448">448</a> <em>     */</em>
<a name="449" href="#449">449</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="450" href="#450">450</a>     <strong>protected</strong> <strong>void</strong> <strong>int</strong>ernalDeepCopy(Object orig, Object dest, <strong>int</strong> maxDepth, Set&lt;String> fieldNamesToSkip, <strong>boolean</strong> ignoreNulls, <strong>boolean</strong> autoConvert) {
<a name="451" href="#451">451</a>         <strong>if</strong> (orig == <strong>null</strong> || dest == <strong>null</strong>) {
<a name="452" href="#452">452</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"original object and destination object must not be null, if you want to clone the object then use the clone method"</span>);
<a name="453" href="#453">453</a>         }
<a name="454" href="#454">454</a> 
<a name="455" href="#455">455</a>         <strong>int</strong> currentDepth = 1;
<a name="456" href="#456">456</a>         Class&lt;?> origClass = orig.getClass();
<a name="457" href="#457">457</a>         Class&lt;?> destClass = dest.getClass();
<a name="458" href="#458">458</a> 
<a name="459" href="#459">459</a>         <em class="comment">// check if copy is possible first</em>
<a name="460" href="#460">460</a>         <strong>if</strong> (ConstructorUtils.getImmutableTypes().contains(destClass)) {
<a name="461" href="#461">461</a>             <em class="comment">// cannot copy to an immutable object</em>
<a name="462" href="#462">462</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot copy to an immutable object"</span>);
<a name="463" href="#463">463</a>         }
<a name="464" href="#464">464</a>         <strong>if</strong> (autoConvert &amp;&amp; ! ConstructorUtils.isClassBean(origClass) ) {
<a name="465" href="#465">465</a>             <em class="comment">// attempt to convert non-beans into the type we are copying to, fail if it does not work</em>
<a name="466" href="#466">466</a>             <em class="comment">// This has to be done because the copy will simply fail if we try to copy between non-beans which are not equivalent</em>
<a name="467" href="#467">467</a>             <strong>try</strong> {
<a name="468" href="#468">468</a>                 orig = getConversionUtils().convert(orig, destClass);
<a name="469" href="#469">469</a>                 origClass = destClass;
<a name="470" href="#470">470</a>             } <strong>catch</strong> (UnsupportedOperationException e) {
<a name="471" href="#471">471</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot copy from an immutable object to a complex object without converter support"</span>);
<a name="472" href="#472">472</a>             }
<a name="473" href="#473">473</a>         }
<a name="474" href="#474">474</a>         <em class="comment">// copy orig to dest</em>
<a name="475" href="#475">475</a>         <strong>try</strong> {
<a name="476" href="#476">476</a>             <strong>if</strong> (origClass.isArray()) {
<a name="477" href="#477">477</a>                 <em class="comment">// special case, copy and overwrite existing array values</em>
<a name="478" href="#478">478</a>                 <strong>if</strong> (destClass.isArray()) {
<a name="479" href="#479">479</a>                     <em class="comment">// TODO if the dest array is empty then fail</em>
<a name="480" href="#480">480</a>                     <strong>try</strong> {
<a name="481" href="#481">481</a>                         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; Array.getLength(orig); i++) {
<a name="482" href="#482">482</a>                             Object value = Array.get(orig, i);
<a name="483" href="#483">483</a>                             <strong>if</strong> (ignoreNulls &amp;&amp; value == <strong>null</strong>) {
<a name="484" href="#484">484</a>                                 <em class="comment">// don't copy this null over the existing value</em>
<a name="485" href="#485">485</a>                             } <strong>else</strong> {
<a name="486" href="#486">486</a>                                 Array.set(dest, i, 
<a name="487" href="#487">487</a>                                         internalDeepClone(value, CopyDestination.ORIGINAL, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, false));
<a name="488" href="#488">488</a>                             }
<a name="489" href="#489">489</a>                         }
<a name="490" href="#490">490</a>                     } <strong>catch</strong> (ArrayIndexOutOfBoundsException e) {
<a name="491" href="#491">491</a>                         <em class="comment">// partial copy is ok, continue on</em>
<a name="492" href="#492">492</a>                     }
<a name="493" href="#493">493</a>                 } <strong>else</strong> {
<a name="494" href="#494">494</a>                     <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot copy a simple value to a complex object"</span>);                  
<a name="495" href="#495">495</a>                 }
<a name="496" href="#496">496</a>             } <strong>else</strong> <strong>if</strong> (Collection.<strong>class</strong>.isAssignableFrom(origClass)) {
<a name="497" href="#497">497</a>                 <em class="comment">// special case, copy everything from orig and add to dest</em>
<a name="498" href="#498">498</a>                 <strong>for</strong> (Object value : (Collection) orig) {
<a name="499" href="#499">499</a>                     <strong>if</strong> (ignoreNulls &amp;&amp; value == <strong>null</strong>) {
<a name="500" href="#500">500</a>                         <em class="comment">// don't copy this null over the existing value</em>
<a name="501" href="#501">501</a>                     } <strong>else</strong> {
<a name="502" href="#502">502</a>                         ((Collection) dest).add( 
<a name="503" href="#503">503</a>                                 internalDeepClone(value, CopyDestination.ORIGINAL, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, false));
<a name="504" href="#504">504</a>                     }
<a name="505" href="#505">505</a>                 }
<a name="506" href="#506">506</a>             } <strong>else</strong> <strong>if</strong> (Map.<strong>class</strong>.isAssignableFrom(origClass)) {
<a name="507" href="#507">507</a>                 <em class="comment">// special case clone everything in the map except keys</em>
<a name="508" href="#508">508</a>                 <strong>for</strong> (Object key : ((Map) orig).keySet()) {
<a name="509" href="#509">509</a>                     <strong>if</strong> ( fieldNamesToSkip != <strong>null</strong>
<a name="510" href="#510">510</a>                             &amp;&amp; fieldNamesToSkip.contains(key) ) {
<a name="511" href="#511">511</a>                         <strong>continue</strong>; <em class="comment">// skip to next</em>
<a name="512" href="#512">512</a>                     }
<a name="513" href="#513">513</a>                     Object value = ((Map) orig).get(key);
<a name="514" href="#514">514</a>                     <strong>if</strong> (ignoreNulls &amp;&amp; value == <strong>null</strong>) {
<a name="515" href="#515">515</a>                         <em class="comment">// don't copy this null over the existing value</em>
<a name="516" href="#516">516</a>                     } <strong>else</strong> {
<a name="517" href="#517">517</a>                         ((Map) dest).put(key, 
<a name="518" href="#518">518</a>                                 internalDeepClone(value, CopyDestination.ORIGINAL, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, false));
<a name="519" href="#519">519</a>                     }
<a name="520" href="#520">520</a>                 }
<a name="521" href="#521">521</a>             } <strong>else</strong> <strong>if</strong> (getFieldAdapter().isAdaptableClass(origClass)) {
<a name="522" href="#522">522</a>                 List&lt;String> propertyNames = getFieldAdapter().getPropertyNames(orig);
<a name="523" href="#523">523</a>                 <strong>for</strong> (String name : propertyNames) {
<a name="524" href="#524">524</a>                     <strong>if</strong> ( fieldNamesToSkip != <strong>null</strong>
<a name="525" href="#525">525</a>                             &amp;&amp; fieldNamesToSkip.contains(name) ) {
<a name="526" href="#526">526</a>                         <strong>continue</strong>; <em class="comment">// skip to next</em>
<a name="527" href="#527">527</a>                     }
<a name="528" href="#528">528</a>                     <strong>try</strong> {
<a name="529" href="#529">529</a>                         Object value = getFieldAdapter().getSimpleValue(orig, name);
<a name="530" href="#530">530</a>                         <strong>if</strong> (ignoreNulls &amp;&amp; value == <strong>null</strong>) {
<a name="531" href="#531">531</a>                             <em class="comment">// don't copy this null over the existing value</em>
<a name="532" href="#532">532</a>                         } <strong>else</strong> {
<a name="533" href="#533">533</a>                             getFieldUtils().setFieldValue(dest, name, 
<a name="534" href="#534">534</a>                                     internalDeepClone(value, CopyDestination.ORIGINAL, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, false));
<a name="535" href="#535">535</a>                         }
<a name="536" href="#536">536</a>                     } <strong>catch</strong> (FieldnameNotFoundException e) {
<a name="537" href="#537">537</a>                         <em class="comment">// it is ok for the objects to not be the same</em>
<a name="538" href="#538">538</a>                     } <strong>catch</strong> (IllegalArgumentException e) {
<a name="539" href="#539">539</a>                         <em class="comment">// it is ok for the objects to not be the same</em>
<a name="540" href="#540">540</a>                     }
<a name="541" href="#541">541</a>                 }
<a name="542" href="#542">542</a>             } <strong>else</strong> {
<a name="543" href="#543">543</a>                 <em class="comment">// regular javabean</em>
<a name="544" href="#544">544</a>                 Map&lt;String, Object> values = getFieldUtils().getFieldValues(orig, FieldsFilter.READABLE, false);
<a name="545" href="#545">545</a>                 <strong>for</strong> (Entry&lt;String, Object> entry : values.entrySet()) {
<a name="546" href="#546">546</a>                     String name = entry.getKey();
<a name="547" href="#547">547</a>                     <strong>if</strong> (ClassFields.FIELD_CLASS.equals(name)) {
<a name="548" href="#548">548</a>                         <strong>continue</strong>; <em class="comment">// No point in trying to set an object's class</em>
<a name="549" href="#549">549</a>                     }
<a name="550" href="#550">550</a>                     <strong>if</strong> ( fieldNamesToSkip != <strong>null</strong>
<a name="551" href="#551">551</a>                             &amp;&amp; fieldNamesToSkip.contains(name) ) {
<a name="552" href="#552">552</a>                         <strong>continue</strong>; <em class="comment">// skip to next</em>
<a name="553" href="#553">553</a>                     }
<a name="554" href="#554">554</a>                     <strong>try</strong> {
<a name="555" href="#555">555</a>                         Object value = getFieldUtils().getFieldValue(orig, name);
<a name="556" href="#556">556</a>                         <strong>if</strong> (ignoreNulls &amp;&amp; value == <strong>null</strong>) {
<a name="557" href="#557">557</a>                             <em class="comment">// don't copy this null over the existing value</em>
<a name="558" href="#558">558</a>                         } <strong>else</strong> {
<a name="559" href="#559">559</a>                             getFieldUtils().setFieldValue(dest, name, 
<a name="560" href="#560">560</a>                                     internalDeepClone(value, CopyDestination.ORIGINAL, maxDepth, <strong>null</strong>, currentDepth, ignoreNulls, false));
<a name="561" href="#561">561</a>                         }
<a name="562" href="#562">562</a>                     } <strong>catch</strong> (FieldnameNotFoundException e) {
<a name="563" href="#563">563</a>                         <em class="comment">// this is ok, field might not exist or might not be readable so we skip it</em>
<a name="564" href="#564">564</a>                     } <strong>catch</strong> (FieldGetValueException e) {
<a name="565" href="#565">565</a>                         <em class="comment">// this is ok, field might not be readable</em>
<a name="566" href="#566">566</a>                     } <strong>catch</strong> (FieldSetValueException e) {
<a name="567" href="#567">567</a>                         <em class="comment">// this is ok, field might not be writeable</em>
<a name="568" href="#568">568</a>                     } <strong>catch</strong> (IllegalArgumentException e) {
<a name="569" href="#569">569</a>                         <em class="comment">// this is ok, failure should not stop the clone</em>
<a name="570" href="#570">570</a>                     }
<a name="571" href="#571">571</a>                 }
<a name="572" href="#572">572</a>             }
<a name="573" href="#573">573</a>         } <strong>catch</strong> (Exception e) {
<a name="574" href="#574">574</a>             <em class="comment">// catch any possible thrown exception and translate (this is not a mistake so ignore findbugs)</em>
<a name="575" href="#575">575</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Failure copying "</span> + orig + <span class="string">" ("</span>+origClass+<span class="string">") to "</span> 
<a name="576" href="#576">576</a>                     + dest + <span class="string">" ("</span>+destClass+<span class="string">")"</span> + e.getMessage(), e);
<a name="577" href="#577">577</a>         }
<a name="578" href="#578">578</a>     }
<a name="579" href="#579">579</a> 
<a name="580" href="#580">580</a>     @Override
<a name="581" href="#581">581</a>     <strong>public</strong> String toString() {
<a name="582" href="#582">582</a>         <strong>return</strong> <span class="string">"Deep:"</span>+getClassDataCacher();
<a name="583" href="#583">583</a>     }
<a name="584" href="#584">584</a> 
<a name="585" href="#585">585</a>     <em class="comment">// STATIC access</em>
<a name="586" href="#586">586</a> 
<a name="587" href="#587">587</a>     <strong>protected</strong> <strong>static</strong> SoftReference&lt;DeepUtils> instanceStorage;
<a name="588" href="#588">588</a>     <em>/**<em>*</em></em>
<a name="589" href="#589">589</a> <em>     * Get a singleton instance of this class to work with (stored statically) &lt;br/></em>
<a name="590" href="#590">590</a> <em>     * &lt;b>WARNING&lt;/b>: do not hold onto this object or cache it yourself, call this method again if you need it again</em>
<a name="591" href="#591">591</a> <em>     * @return a singleton instance of this class</em>
<a name="592" href="#592">592</a> <em>     */</em>
<a name="593" href="#593">593</a>     <strong>public</strong> <strong>static</strong> <a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a> getInstance() {
<a name="594" href="#594">594</a>         <a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a> instance = (instanceStorage == <strong>null</strong> ? <strong>null</strong> : instanceStorage.get());
<a name="595" href="#595">595</a>         <strong>if</strong> (instance == <strong>null</strong>) {
<a name="596" href="#596">596</a>             instance = DeepUtils.setInstance(<strong>null</strong>);
<a name="597" href="#597">597</a>         }
<a name="598" href="#598">598</a>         <strong>return</strong> instance;
<a name="599" href="#599">599</a>     }
<a name="600" href="#600">600</a>     <em>/**<em>*</em></em>
<a name="601" href="#601">601</a> <em>     * Set the singleton instance of the class which will be stored statically</em>
<a name="602" href="#602">602</a> <em>     * @param instance the instance to use as the singleton instance</em>
<a name="603" href="#603">603</a> <em>     */</em>
<a name="604" href="#604">604</a>     <strong>public</strong> <strong>static</strong> <a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a> setInstance(<a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a> newInstance) {
<a name="605" href="#605">605</a>         <a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a> instance = newInstance;
<a name="606" href="#606">606</a>         <strong>if</strong> (instance == <strong>null</strong>) {
<a name="607" href="#607">607</a>             instance = <strong>new</strong> <a href="../../../org/azeckoski/reflectutils/DeepUtils.html">DeepUtils</a>();
<a name="608" href="#608">608</a>             instance.singleton = <strong>true</strong>;
<a name="609" href="#609">609</a>         }
<a name="610" href="#610">610</a>         DeepUtils.timesCreated++;
<a name="611" href="#611">611</a>         instanceStorage = <strong>new</strong> SoftReference&lt;DeepUtils>(instance);
<a name="612" href="#612">612</a>         <strong>return</strong> instance;
<a name="613" href="#613">613</a>     }
<a name="614" href="#614">614</a> 
<a name="615" href="#615">615</a>     <strong>private</strong> <strong>static</strong> <strong>int</strong> timesCreated = 0;
<a name="616" href="#616">616</a>     <strong>public</strong> <strong>static</strong> <strong>int</strong> getTimesCreated() {
<a name="617" href="#617">617</a>         <strong>return</strong> timesCreated;
<a name="618" href="#618">618</a>     }
<a name="619" href="#619">619</a> 
<a name="620" href="#620">620</a>     <strong>private</strong> <strong>boolean</strong> singleton = false;
<a name="621" href="#621">621</a>     <em>/**<em>*</em></em>
<a name="622" href="#622">622</a> <em>     * @return true if this object is the singleton</em>
<a name="623" href="#623">623</a> <em>     */</em>
<a name="624" href="#624">624</a>     <strong>public</strong> <strong>boolean</strong> isSingleton() {
<a name="625" href="#625">625</a>         <strong>return</strong> singleton;
<a name="626" href="#626">626</a>     }
<a name="627" href="#627">627</a> 
<a name="628" href="#628">628</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

